/*
 * Copyright 2011 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.android.apps.mytracks.services.sensors.ant;

import com.google.android.apps.mytracks.content.Sensor.SensorDataSet;

/**
 * This interface defines the common functionality exposed by plug-in sensor
 * handlers used by {@link AntDirectSensorManager}.
 *
 * @author Matthew Simmons
 */
interface AntSensorHandler {
  /** Returns the sensor handled by this instance */
  public AntSensor getSensorType();

  /**
   * Returns the channel number to be used when communicating with this sensor.
   */
  public byte getChannelNumber();

  /**
   * Returns the device number for a specific instance of the sensor handled
   * by this sensor handler.
   */
  public short getDeviceNumber();

  /**
   * Set the device number for this sensor handler.
   */
  public void setDeviceNumber(short deviceNumber);

  /**
   * Parse a broadcast data message from the handled sensor.
   * @return the parsed data from the broadcast data message.  If the message
   *     was invalid, this method will return null.
   */
  public SensorDataSet handleBroadcastData(byte[] antMessage);
}
